# Ceon URI Mapping

probably the best Zen Cart URI Mapping/SEO Module in the world! ...ever!

Click here to get more great software from Ceon

- Overview |
- Installation |
- Configuration |
- FAQs |
- Support |
- Revision History |
- Upgrading |
- Module Info |
- Module Features

## Downloading the Latest Version

The latest version of the module distribution can always be found on its website, http://ceon.net/software/business/zen-cart/uri-mapping/downloads.

## Upgrading

Simply follow the instructions for the version of Ceon URI Mapping already installed..

1. Upgrading to Version 4.4.1 from Version 4.4.0
2. Upgrading to Version 4.4.1 from Version 4.2.x
3. Upgrading to Version 4.4.1 from Version 4.0.6 - 4.0.8
4. Upgrading to Version 4.4.1 from Version 4.0.0 - 4.0.5
5. Upgrading to Version 4.4.1 from Version 2.x/3.x

## Upgrading to Ceon URI Mapping 4.4.1 from Ceon URI Mapping 4.4.0

Nothing has actually changed from 4.4.0 to 4.4.1, except the version number!

1. #### Automatically update the version number in the database

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin and the module will be updated automagically!

Back to top

## Upgrading to Ceon URI Mapping 4.4.1 from Ceon URI Mapping 4.2.x

It's simple to upgrade to version 4.4.1 from 4.2.x.

1. #### Copy the New/Updated Files across

   These are the new/updated files which make up this module. Copy them all into their respective folders in the Zen Cart installation, overwriting the files from the previously installed version.

   ##### New/Updated files for the Admin directory

   Most Zen Cart stores have their admin directory renamed from the default of “admin”.

   Copy all of the folders and files from the files/admin folder into the store's “admin” directory, whatever it is called.

   The files are already in the correct directory structure, so a single drag-and-drop of the folders/files in the files/admin folder into the “admin” directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   - admin/images/ceon-button-logo.png
   - admin/images/ceon-input-fade-tb-gray-white.png
   - admin/images/ceon-tab-background.png
   - admin/images/ceon-tab-background-selected.png
   - admin/includes/classes/class.CeonURIMappingAdminCategoryPages.php
   - admin/includes/classes/class.CeonURIMappingAdminEZPagePages.php
   - admin/includes/classes/class.CeonURIMappingAdminManufacturerPages.php
   - admin/includes/classes/class.CeonURIMappingAdminProductPages.php
   - admin/includes/classes/class.CeonURIMappingConfigUtility.php
   - admin/includes/classes/class.CeonURIMappingInstallationCheck.php
   - admin/includes/classes/class.CeonURIMappingInstallOrUpgrade.php
   - admin/includes/classes/class.CeonURIMappingTabbedPanelAdminInterface.php
   - admin/includes/classes/class.CeonURIMappingVersion.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_product_pages.php
   - admin/includes/functions/extra_functions/ceon_uri_mapping_admin_page_reg.php
   - admin/includes/languages/english/extra_definitions/ceon_uri_mapping.php
   - admin/includes/languages/english/ceon_uri_mapping_admin_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_category_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_config.php
   - admin/includes/languages/english/ceon_uri_mapping_default_uri_parts.php
   - admin/includes/languages/english/ceon_uri_mapping_ezpage_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_installation_check.php
   - admin/includes/languages/english/ceon_uri_mapping_manufacturer_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_product_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_tabbed_panel_admin_interface.php
   - admin/ceon_uri_mapping_config.php
   - admin/ceon_uri_mapping_installation_check.php

   ###### Additional File for Zen Cart 1.3.x

   Copy the file from the files/additional_file_for_1.3.x/admin folder into the store's “admin” directory, whatever it is called.

   - admin/includes/boxes/extra_boxes/ceon_uri_mapping_modules_dhtml.php

   ##### Updated files for the main store directory

   Copy the includes folder from the files folder into the store's main directory.

   The files are already in the correct directory structure, so a single drag-and-drop of the folder into the root directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   Warning: Be careful NOT to copy the files from the files/includes folder into the store's admin/includes directory, they go in the includes directory which is alongside, not inside the store's admin directory.

   - includes/auto_loaders/config.ceon_uri_mapping.php
   - includes/classes/transliteration (* This directory and ALL files in it!)
   - includes/classes/class.CeonURIMappingAdmin.php
   - includes/classes/class.CeonURIMappingAdminCategories.php
   - includes/classes/class.CeonURIMappingAdminCategoriesProducts.php
   - includes/classes/class.CeonURIMappingAdminEZPages.php
   - includes/classes/class.CeonURIMappingAdminManufacturers.php
   - includes/classes/class.CeonURIMappingAdminProducts.php
   - includes/classes/class.CeonURIMappingDBLookup.php
   - includes/classes/class.CeonURIMappingHandler.php
   - includes/classes/class.CeonURIMappingHandlerBase.php
   - includes/classes/class.CeonURIMappingHREFLinkBuilder.php
   - includes/classes/class.String.php
   - includes/classes/class.Transliteration.php
   - includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - includes/extra_datafiles/ceon_uri_mapping_product_pages.php

2. #### Modify an additional Zen Cart Core File

   An additional core Zen Cart file should be modified, to add the new support for outputting static URIs instead of dynamic URIs in Zen Cart's admin.

   - It is likely that this file has not been modified for the store already, in which case it should be possible to simply back up the file and then overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/functions/html_output.php

3. #### Automatically update the database and configuration

   This software comes with some intelligent upgrade and error checking functionality which makes it easy to keep the database and configuration up to date.

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin and the module will be updated automagically!

4. #### Run the Installation Check

   The installation check will examine all the core files that must be modified for Ceon URI Mapping to work optimally, and warn you if any of the modifications are missing or out of date, again giving information on what you should do!

   A quick glance at this admin page should help you identify and fix any problems with the installation quickly and easily!

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

   - Then go to the Installation Check tab and click on the link to open the Installation Check utility page.

   - The module will now automatically carry out the installation check.

   - If any errors are listed, follow the instructions given by the software.

5. #### That's it!

   Told you it was simple to upgrade!

Back to top

## Upgrading to Ceon URI Mapping 4.4.1 from Ceon URI Mapping 4.0.6 - 4.0.8

It's simple to upgrade to version 4.4.1 from 4.0.6 - 4.0.8.

1. #### Copy the New/Updated Files across

   These are the new/updated files which make up this module. Copy them all into their respective folders in the Zen Cart installation, overwriting the files from the previously installed version.

   ##### New/Updated files for the Admin directory

   Most Zen Cart stores have their admin directory renamed from the default of “admin”.

   Copy all of the folders and files from the files/admin folder into the store's “admin” directory, whatever it is called.

   The files are already in the correct directory structure, so a single drag-and-drop of the folders/files in the files/admin folder into the “admin” directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   - admin/images/ceon-button-logo.png
   - admin/images/ceon-input-fade-tb-gray-white.png
   - admin/images/ceon-tab-background.png
   - admin/images/ceon-tab-background-selected.png
   - admin/includes/classes/class.CeonURIMappingAdminCategoryPages.php
   - admin/includes/classes/class.CeonURIMappingAdminEZPagePages.php
   - admin/includes/classes/class.CeonURIMappingAdminManufacturerPages.php
   - admin/includes/classes/class.CeonURIMappingAdminProductPages.php
   - admin/includes/classes/class.CeonURIMappingConfigUtility.php
   - admin/includes/classes/class.CeonURIMappingInstallationCheck.php
   - admin/includes/classes/class.CeonURIMappingInstallOrUpgrade.php
   - admin/includes/classes/class.CeonURIMappingTabbedPanelAdminInterface.php
   - admin/includes/classes/class.CeonURIMappingVersion.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_product_pages.php
   - admin/includes/functions/extra_functions/ceon_uri_mapping_admin_page_reg.php
   - admin/includes/languages/english/extra_definitions/ceon_uri_mapping.php
   - admin/includes/languages/english/ceon_uri_mapping_admin_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_category_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_config.php
   - admin/includes/languages/english/ceon_uri_mapping_default_uri_parts.php
   - admin/includes/languages/english/ceon_uri_mapping_ezpage_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_installation_check.php
   - admin/includes/languages/english/ceon_uri_mapping_manufacturer_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_product_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_tabbed_panel_admin_interface.php
   - admin/ceon_uri_mapping_config.php
   - admin/ceon_uri_mapping_installation_check.php

   ###### Additional File for Zen Cart 1.3.x

   Copy the file from the files/additional_file_for_1.3.x/admin folder into the store's “admin” directory, whatever it is called.

   - admin/includes/boxes/extra_boxes/ceon_uri_mapping_modules_dhtml.php

   ##### Updated files for the main store directory

   Copy the includes folder from the files folder into the store's main directory.

   The files are already in the correct directory structure, so a single drag-and-drop of the folder into the root directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   Warning: Be careful NOT to copy the files from the files/includes folder into the store's admin/includes directory, they go in the includes directory which is alongside, not inside the store's admin directory.

   - includes/auto_loaders/config.ceon_uri_mapping.php
   - includes/classes/transliteration (* This directory and ALL files in it!)
   - includes/classes/class.CeonURIMappingAdmin.php
   - includes/classes/class.CeonURIMappingAdminCategories.php
   - includes/classes/class.CeonURIMappingAdminCategoriesProducts.php
   - includes/classes/class.CeonURIMappingAdminEZPages.php
   - includes/classes/class.CeonURIMappingAdminManufacturers.php
   - includes/classes/class.CeonURIMappingAdminProducts.php
   - includes/classes/class.CeonURIMappingDBLookup.php
   - includes/classes/class.CeonURIMappingHandler.php
   - includes/classes/class.CeonURIMappingHandlerBase.php
   - includes/classes/class.CeonURIMappingHREFLinkBuilder.php
   - includes/classes/class.String.php
   - includes/classes/class.Transliteration.php
   - includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - includes/extra_datafiles/ceon_uri_mapping_product_pages.php

2. #### Modify an additional Zen Cart Core File

   An additional core Zen Cart file should be modified, to add the new support for outputting static URIs instead of dynamic URIs in Zen Cart's admin.

   - It is likely that this file has not been modified for the store already, in which case it should be possible to simply back up the file and then overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/functions/html_output.php

3. #### Update a Zen Cart Core File already used by Ceon URI Mapping

   A core Zen Cart file that was modified for the previously installed version should be updated, as the code in it has changed slightly.

   - If this file was only modified when installing a previous version of Ceon URI Mapping, then it should be possible to simply back up the file and then simply overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/functions/general.php

4. #### Automatically update the database and configuration

   This software comes with some intelligent upgrade and error checking functionality which makes it easy to keep the database and configuration up to date.

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin and the module will be updated automagically!

5. #### Run the Installation Check

   The installation check will examine all the core files that must be modified for Ceon URI Mapping to work optimally, and warn you if any of the modifications are missing or out of date, again giving information on what you should do!

   A quick glance at this admin page should help you identify and fix any problems with the installation quickly and easily!

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

   - Then go to the Installation Check tab and click on the link to open the Installation Check utility page.

   - The module will now automatically carry out the installation check.

   - If any errors are listed, follow the instructions given by the software.

6. #### That's it!

   Told you it was simple to upgrade!

Back to top

## Upgrading to Ceon URI Mapping 4.4.1 from Ceon URI Mapping 4.0.0 - 4.0.5

It's simple to upgrade to version 4.4.1 from 4.0.0 - 4.0.5.

1. #### Copy the Updated Files across

   These are the updated files which make up this module. Copy them all into their respective folders in the Zen Cart installation, overwriting the files from the previously installed version.

   ##### New/updated files for the Admin directory

   Most Zen Cart stores have their admin directory renamed from the default of “admin”.

   Copy all of the folders and files from the files/admin folder into the store's “admin” directory, whatever it is called.

   The files are already in the correct directory structure, so a single drag-and-drop of the folders/files in the files/admin folder into the “admin” directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   - admin/images/ceon-button-logo.png
   - admin/images/ceon-input-fade-tb-gray-white.png
   - admin/images/ceon-tab-background.png
   - admin/images/ceon-tab-background-selected.png
   - admin/includes/classes/class.CeonURIMappingAdminCategoryPages.php
   - admin/includes/classes/class.CeonURIMappingAdminEZPagePages.php
   - admin/includes/classes/class.CeonURIMappingAdminManufacturerPages.php
   - admin/includes/classes/class.CeonURIMappingAdminProductPages.php
   - admin/includes/classes/class.CeonURIMappingConfigUtility.php
   - admin/includes/classes/class.CeonURIMappingInstallationCheck.php
   - admin/includes/classes/class.CeonURIMappingInstallOrUpgrade.php
   - admin/includes/classes/class.CeonURIMappingTabbedPanelAdminInterface.php
   - admin/includes/classes/class.CeonURIMappingVersion.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_product_pages.php
   - admin/includes/functions/extra_functions/ceon_uri_mapping_admin_page_reg.php
   - admin/includes/languages/english/extra_definitions/ceon_uri_mapping.php
   - admin/includes/languages/english/ceon_uri_mapping_admin_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_category_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_config.php
   - admin/includes/languages/english/ceon_uri_mapping_default_uri_parts.php
   - admin/includes/languages/english/ceon_uri_mapping_ezpage_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_installation_check.php
   - admin/includes/languages/english/ceon_uri_mapping_manufacturer_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_product_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_tabbed_panel_admin_interface.php
   - admin/ceon_uri_mapping_config.php
   - admin/ceon_uri_mapping_installation_check.php

   ###### Additional File for Zen Cart 1.3.x

   Copy the file from the files/additional_file_for_1.3.x/admin folder into the store's “admin” directory, whatever it is called.

   - admin/includes/boxes/extra_boxes/ceon_uri_mapping_modules_dhtml.php

   ##### New/updated files for the main store directory

   Copy the includes folder from the files folder into the store's main directory.

   The files are already in the correct directory structure, so a single drag-and-drop of the folder into the root directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   Warning: Be careful NOT to copy the files from the files/includes folder into the store's admin/includes directory, they go in the includes directory which is alongside, not inside the store's admin directory.

   - includes/auto_loaders/config.ceon_uri_mapping.php
   - includes/classes/transliteration (* This directory and ALL files in it!)
   - includes/classes/class.CeonURIMappingAdmin.php
   - includes/classes/class.CeonURIMappingAdminCategories.php
   - includes/classes/class.CeonURIMappingAdminCategoriesProducts.php
   - includes/classes/class.CeonURIMappingAdminEZPages.php
   - includes/classes/class.CeonURIMappingAdminManufacturers.php
   - includes/classes/class.CeonURIMappingAdminProducts.php
   - includes/classes/class.CeonURIMappingDBLookup.php
   - includes/classes/class.CeonURIMappingHandler.php
   - includes/classes/class.CeonURIMappingHandlerBase.php
   - includes/classes/class.CeonURIMappingHREFLinkBuilder.php
   - includes/classes/class.String.php
   - includes/classes/class.Transliteration.php
   - includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - includes/extra_datafiles/ceon_uri_mapping_product_pages.php
   - includes/languages/english/ceon_uri_mapping_admin.php

2. #### Modify an additional Zen Cart Core File

   An additional core Zen Cart file should be modified, to add the new support for outputting static URIs instead of dynamic URIs in Zen Cart's admin.

   - It is likely that this file has not been modified for the store already, in which case it should be possible to simply back up the file and then overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/functions/html_output.php

3. #### Update a Zen Cart Core File already used by Ceon URI Mapping

   A core Zen Cart file that was modified for the previously installed version should be updated, as the code in it has changed slightly.

   - If this file was only modified when installing a previous version of Ceon URI Mapping, then it should be possible to simply back up the file and then simply overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/functions/general.php

4. #### [Optional but RECOMMENDED] Update a “Document General” Product Type Core File used by Ceon URI Mapping

   For stores using the Document General product type and Zen Cart 1.3.9h or Zen Cart 1.5.0, a core Zen Cart file that was modified for the previously installed version should be updated, as there was a typo in the with versions 4.0.0 - 4.0.5.

   Other stores (those not using the Document General product type) can skip this step, if desired.

   - If this file was only modified when installing a previous version of Ceon URI Mapping, then it should be possible to simply back up the file and then simply overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if the core file has also been modified for the store for other third party modules, the changes within the sample file included in this distribution must be applied carefully to the core file.

     The changes are clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to the core file which has previously been modified - can be found in this FAQ.

   ##### Modified core file for the Admin directory

   Please Note: If copying the file across, and the admin folder for the store is not named “admin”, then care must be taken to place the file from within the modified_core_files/ZC-version/admin folder into the store's admin folder.

   - admin/includes/modules/document_general/collect_info.php

5. #### Automatically update the database and configuration

   This software comes with some intelligent upgrade and error checking functionality which makes it easy to keep the database and configuration up to date.

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin and the module will be updated automagically!

6. #### Run the Installation Check

   The installation check will examine all the core files that must be modified for Ceon URI Mapping to work optimally, and warn you if any of the modifications are missing or out of date, again giving information on what you should do!

   A quick glance at this admin page should help you identify and fix any problems with the installation quickly and easily!

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

   - Then go to the Installation Check tab and click on the link to open the Installation Check utility page.

   - The module will now automatically carry out the installation check.

   - If any errors are listed, follow the instructions given by the software.

7. #### That's it!

   Told you it was simple to upgrade!

Back to top

## Upgrading to Ceon URI Mapping 4.4.1 from Ceon URI Mapping 2.x/3.x

Ceon URI Mapping 4.x is a complete rewrite of the software.

Upgrading from an earlier version to 4.4.1 will take a little bit of time, but is easy to do.

The great thing is that once you've upgraded, not only will the software be better, but version 4.4.1 has a completely new file structure, and auto-upgrading functionality, which means that any subsequent upgrades (to 4.4.1, 4.2.2 etc.) will take just a few seconds!

So once v4.4.1 is installed, it'll be simple to keep up to date and to keep getting all the extra features new versions provide!

1. #### Remove the old files used by the previously installed version of the module

   Since the module has been rewritten to use a new class based structure, many of the old files are no longer used and need to be removed.

   Please Note: The list below is exhaustive.. it may well be that several of these files are not present in the store's folders.. that's not a problem, some files only came with very specific versions of the software and may simply never have been part of the version of the software installed on the store's website.

   ##### Folder and files to be deleted from the Admin directory

   Most Zen Cart stores have their admin directory renamed from the default of “admin”.

   Delete any of the following files that exist in the store's “admin” directory, whatever it is called.

   - admin/includes/classes/transliteration (Delete this folder and all files in it)
   - admin/includes/classes/class.String.php
   - admin/includes/classes/class.Transliteration.php
   - admin/includes/functions/extra_functions/ceon_uri_mapping.php
   - admin/ceon_uri_mapping_auto_upgrade.php

   ##### Files to be deleted from the main store directory

   - includes/extra_datafiles/ceon_uri_mapping_config.php
   - includes/functions/ceon_uri_mapping_functions.php
   - includes/init_includes/init_ceon_uri_mapping.php
   - includes/templates/template_default/jscript/jscript_ceon_uri_mapping_canonical_link_header_tag.php

2. #### Copy the New/Updated Files across

   These are the new and updated files which make up this module. Copy them all into their respective folders in the Zen Cart installation, overwriting any which remain from the previously installed version.

   Most files are used by all Zen Cart versions.

   There is an additional file which is used only by Zen Cart 1.3.x; if the store uses Zen Cart 1.3.x, be sure to copy this extra file across from the folder files/additional_file_for_1.3.x.

   ##### New/updated files for the Admin directory

   Most Zen Cart stores have their admin directory renamed from the default of “admin”.

   Copy all of the folders and files from the files/admin folder into the store's “admin” directory, whatever it is called.

   The files are already in the correct directory structure, so a single drag-and-drop of the folders/files in the files/admin folder into the “admin” directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   - admin/images/ceon-button-logo.png
   - admin/images/ceon-input-fade-tb-gray-white.png
   - admin/images/ceon-tab-background.png
   - admin/images/ceon-tab-background-selected.png
   - admin/includes/classes/class.CeonURIMappingAdminCategoryPages.php
   - admin/includes/classes/class.CeonURIMappingAdminEZPagePages.php
   - admin/includes/classes/class.CeonURIMappingAdminManufacturerPages.php
   - admin/includes/classes/class.CeonURIMappingAdminProductPages.php
   - admin/includes/classes/class.CeonURIMappingConfigUtility.php
   - admin/includes/classes/class.CeonURIMappingInstallationCheck.php
   - admin/includes/classes/class.CeonURIMappingInstallOrUpgrade.php
   - admin/includes/classes/class.CeonURIMappingTabbedPanelAdminInterface.php
   - admin/includes/classes/class.CeonURIMappingVersion.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - admin/includes/extra_datafiles/ceon_uri_mapping_product_pages.php
   - admin/includes/functions/extra_functions/ceon_uri_mapping_admin_page_reg.php
   - admin/includes/languages/english/extra_definitions/ceon_uri_mapping.php
   - admin/includes/languages/english/ceon_uri_mapping_admin_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_category_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_config.php
   - admin/includes/languages/english/ceon_uri_mapping_default_uri_parts.php
   - admin/includes/languages/english/ceon_uri_mapping_ezpage_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_installation_check.php
   - admin/includes/languages/english/ceon_uri_mapping_manufacturer_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_product_pages.php
   - admin/includes/languages/english/ceon_uri_mapping_tabbed_panel_admin_interface.php
   - admin/ceon_uri_mapping_config.php
   - admin/ceon_uri_mapping_installation_check.php

   ###### Additional File for Zen Cart 1.3.x

   Copy the file from the files/additional_file_for_1.3.x/admin folder into the store's “admin” directory, whatever it is called.

   - admin/includes/boxes/extra_boxes/ceon_uri_mapping_modules_dhtml.php

   ##### New/updated files for the main store directory

   Copy the includes folder from the files folder into the store's main directory.

   The files are already in the correct directory structure, so a single drag-and-drop of the folder into the root directory for the store will put the files in the correct locations.

   Please do not copy the files individually - there's simply no need - doing so often results in files being missed out!

   Warning: Be careful NOT to copy the files from the files/includes folder into the store's admin/includes directory, they go in the includes directory which is alongside, not inside the store's admin directory.

   - includes/auto_loaders/config.ceon_uri_mapping.php
   - includes/classes/transliteration (* This directory and ALL files in it!)
   - includes/classes/class.CeonURIMappingAdmin.php
   - includes/classes/class.CeonURIMappingAdminCategories.php
   - includes/classes/class.CeonURIMappingAdminCategoriesProducts.php
   - includes/classes/class.CeonURIMappingAdminEZPages.php
   - includes/classes/class.CeonURIMappingAdminManufacturers.php
   - includes/classes/class.CeonURIMappingAdminProducts.php
   - includes/classes/class.CeonURIMappingDBLookup.php
   - includes/classes/class.CeonURIMappingHandler.php
   - includes/classes/class.CeonURIMappingHandlerBase.php
   - includes/classes/class.CeonURIMappingHREFLinkBuilder.php
   - includes/classes/class.String.php
   - includes/classes/class.Transliteration.php
   - includes/extra_datafiles/ceon_uri_mapping_database_tables.php
   - includes/extra_datafiles/ceon_uri_mapping_filenames.php
   - includes/extra_datafiles/ceon_uri_mapping_product_pages.php

3. #### Update the Zen Cart Core Files used by Ceon URI Mapping

   All of the core Zen Cart files that were modified for the previously installed version must be updated to work with the new version.

   There are also some additional files which need to be modified.

   As is mentioned above, this will take a little time, but subsequent versions of the software are unlikely to require further core file modifications so it's important to “get this step over and done with”.

   - If these files were only modified when installing a previous version of Ceon URI Mapping, then it should be possible to simply back up each file and then simply overwrite the file with the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store.

   - However, if any of these core files have also been modified for the store for other third party modules, the changes within the sample files included in this distribution must be applied carefully to the core files.

     The changes are clearly marked within the sample files in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     - Most of the changes between earlier versions are made at the exact same place as they were previously, so it should be quite easy to “merge” the updated code.

     - Don't forget though that some of the files to be modified were not modified for previous verions, so no existing Ceon URI Mapping code will be present in those files.

     - Also, take care to note the numbers in the “marker comments” (1 of X) - for some files there are now fewer modifications than there were previously, so some modifications will also have to be removed when adding the updated modifications.

     Instructions on how to copy across the modifications necessary for this module - to the version of the respective core files which have previously been modified - can be found in this FAQ.

   ##### Modified core files for the Admin directory

   Please Note: If copying the files across, and the admin folder for the store is not named “admin”, then care must be taken to place the files from within the modified_core_files/ZC-version/admin folder into the store's admin folder. Simply copying across the modified_core_files/ZC-version/admin folder won't work!

   If any of the “Product Types” (e.g. Document General or Product Book) aren't used by the store, there's no real need to copy/modify the files in the respective directories (e.g. document_general or product_book). However, error messages will be displayed in the “Installation Check” if it detects unmodified files, so it is best to just take a minute or two and make the modifications now anyway.

   - admin/includes/functions/general.php
   - admin/includes/functions/html_output.php
   - admin/includes/modules/document_general/collect_info.php
   - admin/includes/modules/document_general/preview_info.php
   - admin/includes/modules/document_product/collect_info.php
   - admin/includes/modules/document_product/preview_info.php
   - admin/includes/modules/product/collect_info.php
   - admin/includes/modules/product/preview_info.php
   - admin/includes/modules/product_book/collect_info.php
   - admin/includes/modules/product_book/copy_to_confirm.php
   - admin/includes/modules/product_book/preview_info.php
   - admin/includes/modules/product_book/update_product.php
   - admin/includes/modules/product_free_shipping/collect_info.php
   - admin/includes/modules/product_free_shipping/preview_info.php
   - admin/includes/modules/product_music/collect_info.php
   - admin/includes/modules/product_music/copy_to_confirm.php
   - admin/includes/modules/product_music/preview_info.php
   - admin/includes/modules/product_music/update_product.php
   - admin/includes/modules/copy_to_confirm.php
   - admin/includes/modules/move_product_confirm.php
   - admin/includes/modules/sidebox_move_product.php
   - admin/includes/modules/update_product.php
   - admin/categories.php
   - admin/document_general.php
   - admin/document_product.php
   - admin/ezpages.php
   - admin/manufacturers.php
   - admin/product.php
   - admin/product_free_shipping.php
   - admin/product_music.php

   ##### Modified core files for the main store directory

   Some versions of Zen Cart require modifications that others don't. Just apply the modifications to files that are present in the modified_core_files folder for the version of Zen Cart the store uses.

   If a file doesn't exist in the overrides directory, simply copy the pre-modified sample file from this distribution, for the version of Zen Cart being used by the store, into the overrides folder.

   - includes/auto_loaders/config.canonical.php (Zen Cart 1.3.0 - 1.3.8)
   - includes/functions/html_output.php (Zen Cart 1.3.0 - 1.5.0)
   - includes/init_includes/overrides/init_add_crumbs.php (Zen Cart 1.3.5 - 1.5.0)
   - includes/init_includes/overrides/init_canonical.php (Zen Cart 1.3.0 - 1.5.0)
   - includes/init_includes/overrides/init_currencies.php (Zen Cart 1.3.0 - 1.5.0)
   - includes/init_includes/overrides/init_sessions.php (Zen Cart 1.3.9/1.5.0)

4. #### [Upgrading From Ceon URI Mapping 2.0.0 - 3.6.3] Remove Old Core File Modifications

   If the store is upgrading from version prior to 3.8.0 then there are some Zen Cart core files which will have been modified for the previous version but which no longer require any modifications.

   It is advised that these modifications are removed:

   - The files admin/includes/modules/delete_product_confirm.php and admin/includes/modules/product_music/delete_product_confirm.php no longer need to be modified.

     The modifications can be removed by editing these files and removing all the code including and between the `// BEGIN CEON URI MAPPING 1 of 1` markers, or, if the files have not been modified for any other third party module, by copying over the files with “fresh” versions from the original Zen Cart distribution for the version of Zen Cart the store uses.

5. #### [Upgrading From Ceon URI Mapping 2.0.0 - 3.4.3] Template Files For Zen Cart 1.3.x

   This upgrade step doesn't apply for stores already using version 3.6.0 or later.

   A few of the standard Zen Cart template files require modifications to work with this module as they weren't built in a way that supports static URIs.

   Modifications to existing template files, for static URIs to be able to be used by some of the standard Zen Cart sideboxes and by the product listing filter forms, have been made to “clean” copies of the template files from a “fresh” installation of Zen Cart and are included as “sample” files in this distribution.

   - If any of these template files haven't already been modified for the store, the sample files included in this distribution can be copied into the store's template directory and will then override the standard versions of the files included in the Zen Cart distribution.

   - If any of these template files have already been modified for the store, then the changes necessary to support the use of static URIs must be made to the store's modified file(s). The changes are clearly marked within the sample files in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to template files which have previously been modified - can be found in this FAQ.

   The sample template files can be found within the template_override_files folder in the distribution. They are:

   - includes/templates/STORE-TEMPLATE/sideboxes/tpl_manufacturers_select.php
   - includes/templates/STORE-TEMPLATE/sideboxes/tpl_music_genres_select.php
   - includes/templates/STORE-TEMPLATE/sideboxes/tpl_record_company_select.php
   - includes/templates/STORE-TEMPLATE/templates/tpl_index_product_list.php

6. #### [Zen Cart Versions 1.3.0 - 1.3.8 Only] Enable Canonical URI Support

   This upgrade step doesn't apply for stores using Zen Cart version 1.3.9 or 1.5.0.

   Canonical URI support is an absolutely essential feature of this module, so it must be enabled properly.

   If it isn't, search engines will penalise the site and it may well drop down in its rankings!

   Zen Cart versions 1.3.9 and 1.5.0 have the necessary canonical code built into them already but previous versions of Zen Cart must have a file modified to add this support.

   The file includes/templates/STORE-TEMPLATE/common/html_header.php must be modified.

   - If the template file includes/templates/STORE-TEMPLATE/common/html_header.php does not yet exist, then simply copy across the file from the template_override_files folder for the version of Zen Cart the store is using.

   - If the template file includes/templates/STORE-TEMPLATE/common/html_header.php does exist for the store, then the simple change necessary for canonical URI support must be made to the store's html_header.php.

     The change is clearly marked within the sample file in the distribution and should be easy enough to copy across, especially if a “diff” software package (such as the free WinMerge or the excellent, commercial, Beyond Compare) is used.

     Instructions on how to copy across the modifications necessary for this module - to existing template files - can be found in this FAQ.

7. #### Automatically update the database and configuration

   This software comes with some intelligent upgrade and error checking functionality which makes it easy to keep the database and configuration up to date.

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin and the module will be updated automagically!

8. #### Check/Adjust the New Auto-manage Settings for Products' “Reviews” and “Tell-A-Friend” pages

   This new version of the software has completely rewritten functionality for managing the URI mappings of “Product Related Pages”, such as the various “Reviews” pages and the “Tell-A-Friend” pages.

   In versions prior to 4.0.0, a bug in the software meant that the URI mappings being built for these pages only worked correctly for sites using one language.

   For stores that support multiple languages, it is essential to configure the new “Auto-managed Product Page URIs” settings.

   Even for stores that don't multiple languages, it is highly recommended to check these settings as, if the store doesn't use any of the “Reviews” or “Tell-A-Friend” pages, the settings can be changed so that the store's URI Mapping database doesn't fill up with lots of unused URI Mappings - this makes the software faster and more efficient, minimising preventable slowdown of the site!

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

   - Then go to the Auto-managed Product Page URIs tab, adjust the settings appropriately for the store, and click “Save”.

9. #### Run the Installation Check

   This new version of the software comes with an amazingly handy Installation Check utility.

   The installation check will examine the store's configuration files and warn you about any mistakes in the files which you need to correct, and will even provide full information about what you should do.

   It will also check all the core files that must be modified for Ceon URI Mapping to work optimally, and warn you if any of the modifications are missing or out of date, again giving information on what you should do!

   A quick glance at this new admin page should help you identify and fix any problems with the installation quickly and easily!

   - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

   - Then go to the Installation Check tab and click on the link to open the Installation Check utility page.

   - The module will now automatically carry out the installation check.

   - If any errors are listed, follow the instructions given by the software.

10. #### [OPTIONAL but RECOMMENDED] Update the Rewrite Rule

    The suggested “Example” Rewrite Rule supplied with this distribution has been further optimised, and should result in [slight, but welcome] performance gains for sites using the new format.

    To make things as easy as possible, this new version of the software comes with handy new “Example Rewrite Rule” functionality.

    The module will analyse the filesystem on the server and attempt to build a rewrite rule for the store that has any necessary exclusions added.

    - Go to Modules > Ceon URI Mapping (SEO) Config in the Zen Cart Admin.

    - Then go to the Installation Check tab and click on the link to open the Installation Check utility page.

    - Since any errors with the store's configuration files should have been fixed after running the installation check in the previous step, the “Example Rewrite Rule” panel will be displayed.

    - Read the instructions given in that panel and copy and paste the new Rewrite Rule to the store's .htaccess file/VirtualHost directive, if desired.

    - Remember this is just an Example rewrite rule, and although it's likely to be better than that used for a previous version of the software, it will not have any customisations made by whoever added the original rewrite rule.. so be sure to carefully merge the changes as appropriate - this is your reponsibility!

11. #### [OPTIONAL but RECOMMENDED] Configure the Google Sitemap (XML) Module

    If the store uses the Google Sitemap module, it needs to be configured to work better with static URIs.

    Otherwise, the store's rankings may be penalised because of links in the sitemap redirecting to other links.

    - Go to Configuration > Sitemap XML in the Zen Cart Admin.

    - Make sure that “Generate language_id for default language” is set to “false” .

12. #### [OPTIONAL but RECOMMENDED] Take a note of the FAQs

    Lots of people ask us the same questions. It's worth reading the FAQs.

    At the very least, here are some of the most popular questions that are covered:

    - A session parameter (like “`?zenid=XXXX`”) is being added to the end of the store's URIs.
    - A string beginning with “`?cPath`” is being added to the end of a product's URI.

13. #### That's it!

    It may have taken a wee while this time, but the above should all have been fairly easy to do. And the new Installation Check certainly helps!

    As mentioned previously, that's likely to be the last involved upgrade of this software.. upgrading to subsequent versions will most likely just be a matter of overwriting some files, taking only a few seconds.

    Enjoy the new version of the software, there are hundreds of hours of work in it and we hope you like all the new/improved functionality!

Back to top